home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / misc / quote2.zoo / quote.txt < prev    next >
Text File  |  1992-07-05  |  3KB  |  74 lines
  1. QUOTE V1.6  ©1992 Gareth Blades
  2.  
  3. The programs and documentation are copyright ©1992 Gareth Blades. They may be 
  4. distributed by anyone as long as this document and both programs are unaltered.
  5. The quote files are not copyrighted and may be changed and redistributed with 
  6. this program. All I ask is that a text file also be distributed stating what 
  7. the new/changed files are. I would also appreciate receiving any new quote 
  8. files anybody creates.
  9.  
  10. Distribution
  11.   QUOTE.TTP    - The main quote program.
  12.   QUOTE.CFG    - An example configuration file.
  13.   QUOTE.TXT    - This document.
  14.   QUOTES     - Directory of various quote files.
  15.  
  16. QUOTE
  17. Prints a random quote to the screen.
  18.  
  19. SYNTAX
  20. quote [switches] [quote files]
  21.  
  22. The switches can be any of the following :-
  23.  
  24. -c    Clear the screen before printing the quote.
  25. -h    Displays a help screen.
  26. -r    Consider the rest of the arguments to be a list of quote
  27.         files. One of the files is chosen randomly to work on.
  28. -p    Create a pointer file for the quote file specified or if
  29.     no file is specified the default 'quote' one is assumed.
  30.     The quote file specified should be the next parameter
  31.     after the '-p' option.
  32.  
  33.   If the '-r' switch is used then there must be at least one quote file 
  34. specified.
  35.   If no quote file is specified then the quote file from the configuration file 
  36. is used if present. Otherwise the default quote file 'quote' is used.
  37.   The program has been compiled to work with all 680xx processors.
  38.  
  39.  
  40. FILE FORMAT
  41.  The quote files have the extension '.QTE' and the pointer files which are 
  42. created by the option '-p' have the extension '.PTR'.
  43.  The .QTE file format has been designed to make the creation and editing of 
  44. quote files easy. The quote file is simply a list of quotes with a line 
  45. containing just a hash (#) character as a separator between each quote. At the 
  46. end of the file there must be the normal '#<Cr>' separator followed by 
  47. '#END<Cr>' on the next line.
  48.   After you have created your own quote file you simply run QUOTE using the 
  49. '-p' option and give the name of your quote file (as always omitting the 
  50. extension) to the program and it will automatically create the pointer file for 
  51. it.
  52.  
  53.  
  54. CONFIGURATION FILE
  55.   The configuration file is called 'QUOTE.CFG'. The file does not need to exist 
  56. but if it does then the quote program will read the file word by word and try 
  57. to make sense of what it contains. If a line contains '-c' then the screen is 
  58. cleared. If a line does not start with a '-' then it is assumed that this line 
  59. contains the filename of the quote file to be used (This file can be overruled 
  60. by putting a name of a quote file on the command line).
  61. BUGS
  62.   The random number routine works by taking the time and modulousing that with 
  63. the number of quotes to get the random quote to be printed. This is good enough 
  64. for computers with built in clocks but if it is being used in the bootup 
  65. sequence for computers without clocks then the same few quotes will always be 
  66. printed.
  67.  
  68. Gareth Blades
  69. 157 Stubbington Avenue
  70. North End
  71. Portsmouth
  72. Hants
  73. PO2 0JQ
  74.